Transforms forFolderBean


FolderAddDataSetTransform

Formal Parameter Type Default Required Description
allowBrowseDimension BOOLEAN true false Indicates wheter to render the browser in gaphic mode even in html mode.
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
checkImage STRING IconCheck_colored.gif false Formal parameter: The icon to use to submit the parent folders select box in HTML mode. Used only in HTML mode. For DHTML mode, the CSS contains the image
contextID INTEGER 4 false Formal parameter: The context for the object browser fodler links
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssPrefix STRING   false Prefix to append to all css class names.
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    execTarget STRING   false Determines how the user want's to execute the Report/Document object. If set to "_blank" it will open a new window, if empty the link will be executed in the same window.
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    folderJS STRING   false Formal parameter: The javascript function to execute when you click on the folder links
    folderLinksLocation INTEGER 1 false Indicates where the Object Browser Folder Links will be rendered 1 - Root 2 - All Folders 3 - Project
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    htmlGraphicMode BOOLEAN false false Indicates wheter to render the browser in gaphic mode even in html mode.
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    incrementalFetchNavigationType INTEGER 5 false Formal parameter that specifies which type of incremental fetch navigation will be enabled. Allowed values: a valid bitwise combination of EnumIncrementalFetchProperties.NAVIGATION_BUTTONS_FIRST_LAST and/or EnumIncrementalFetchProperties.NAVIGATION_BUTTONS_PREVIOUS_NEXT , EnumIncrementalFetchProperties.NAVIGATION_BUTTONS_PREVIOUS_NEXT_SET
    incrementalFetchPageBlock INTEGER 5 false Indicates the number of pages to show per block for incremental fetch.
    Default value is 5, so the incremental fetch will render the navigation arrows for moving up and down five pages at the time.
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    levelChangeJS STRING processSelect(this) false Formal parameter: The javascript function to execute when you change the folder level
    levelFlag INTEGER -131073 false Indicates the level of information to use when displaying each folder item.
    The information may include object name, description and other information. Multiple fields might be rendered at the same time. For indicating which fields to show, the value to assign to this formal parameter should be a bitwise flag combining constants such as AbstractFolderTransform.LEVEL_NAME, AbstractFolderTransform.LEVEL_DESCRIPTION, AbstractFolderTransform.LEVEL_OWNER, etc. For a complete list, refer to AbstractFolderTransform.
    Please note that if a layout XML definition is being used for rendering the transform's output, the levelFlag formal parameter value will be ignored. Usage: If name, description and owner should be displayed, the value to assign to the formal parameter would be 7 (1 + 2 + 4). Default value is AbstractFolderTransform.LEVEL_ALL
    objectClickJS STRING   false Formal parameter: The javascript function to execute when you click on a folder's subitem
    orientation INTEGER 2 false Indicates the orientation the dialog to render will have.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = not docked
  • 1 = docked horizontally
  • 2 = docked vertically
    		•
    orientationsAllowed INTEGER 3 false Indicates the orientation modes allowed for the dialog to render.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = no orientations allowed
  • 1 = horizontal orientation allowed
  • 2 = vertical orientation allowed
  • 3 = 1 + 2 (both horiz & vert orientations are allowed)
    		•
    renderForm BOOLEAN false false Indicates whether the transform will render it's own HTML form
    renderLinksAncestors BOOLEAN true false Indicates whether the Ancestors of the Object Browser Folder Links will be rendered
    scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
    By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
    searchBoxJS STRING   false Indicates the javascript function to execute when you key on the search box
    searchJS STRING   false Indicates the javascript function to execute when you click on the search image button
    sortAscending BOOLEAN true false Indicates the order to use while sorting the folder contents.
    By default, the value of this parameter is true, which means that the folder contents will be sorted ascending.
    sortField INTEGER 6 false Indicates the field to use while sorting the folder contents. The value of the formal parameter should be taken from the EnumWebObjectSort enumeration, which indicates the type of field tu use, for example, sorting on name, description, owner, etc.
    The default value is EnumWebObjectSort.WebObjectSortObjectNameFoldersFirst.
    The AbstractFolderTransform.sortAscending and AbstractFolderTransform.sortField parameter are used in conjunction to sort by a particular field on the foder page.
    For example: Setting these parameters to false, and EnumWebObjectSort.WebObjectSortObjectOwner respectively will sort the contents of the folder page in descending order based on the Owner filed
    type STRING   false

    This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

    Possible values for this property are bone ids, its usage depends on the page.
    upFolderJS STRING   false Formal parameter: The JavaScript code to execute when clicking on the up folder link to go to the parent folder
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.